Description

Working on the feature introduced in #470, this update develops the VariabilityContextWrapper. Instead of manually implementing context changes between environment steps, this wrapper enables modifications based on a predefined uniform distribution.

Details on its functionality and usage have been documented. Tests confirm that the wrapper operates correctly.

Additionally, this version includes slight improvements to the info dictionary returned by Sinergym environments. Specifically, the info dictionaries from ReduceObservationWrapper have been simplified.

For more details, check the changelog for this minor update.

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation (update in the documentation)
• Improvement (of an existing feature)
• Others

Checklist:

• I've read the CONTRIBUTION guide (required)
• My change requires a change to the documentation.
• I have updated the tests.
• I have updated the documentation accordingly.
• I have reformatted the code using autopep8 second level aggressive.
• I have reformatted the code using isort.
• I have ensured cd docs && make spelling && make html pass (required if documentation has been updated.)
• I have ensured pytest tests/ -vv pass. (required).
• I have ensured pytype -d import-error sinergym/ pass. (required)

Changelog:

• Info update: removed unnecesary values from MultiZoneReward and ReduceObservationWrapper.
• Environment: save initial context values as attribute if it is specified.
• Wrappers: develop VariabilityContextWrapper.
• Tests: fix ReduceObservation info asserts and create tests for VariabilityContextWrapper.
• Documentation updated with new wrapper information.